doc: Extend edit event options with createHistoryEntry flag #12
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature
As a developer I want to be able to decide if an edit event creates a history entry or not. The flag
createHistoryEntry
defaults totrue
, because in most cases we want to create history entries.Use case
In the open-scd distribution the
Editor
andHistory
are separate addons and whenredo
,undo
are triggered from theHistory
addon it in turn dispatches edit events. When those edit events are consumed in theEditor
addon we do not want to create any history entries.History.ts